doc: improve fs.StatFs property descriptions#62617
Open
akashguptasky wants to merge 1 commit intonodejs:mainfrom
Open
doc: improve fs.StatFs property descriptions#62617akashguptasky wants to merge 1 commit intonodejs:mainfrom
akashguptasky wants to merge 1 commit intonodejs:mainfrom
Conversation
Clarify that bsize and frsize are measured in bytes. Add usage examples showing how to calculate available, free, and total disk space. Explain what statfs.type represents and document that the values are platform-specific. Expand descriptions for files and ffree to mention inodes. Fixes: nodejs#50749
nodejs-github-bot
added
doc
jasnell
approved these changes
Apr 6, 2026
aymen94
approved these changes
Apr 7, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Clarify that
bsizeandfrsizeare measured in bytes. Add usageexamples showing how to calculate available, free, and total disk
space. Explain what
statfs.typerepresents and document that thevalues are platform-specific. Expand descriptions for
filesandffreeto mention inodes.Fixes: #50749